Update linters for VS Code, move files from kobo-common into kpi #4985
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Linter packages are updated to the last versions supported before
deprecating Node 16. (so, these will be updated again soon.)
- Extensions for VS Code are working again.
(recent auto-updates dropped support for the versions we were on)
Moving these support files directly into the kpi repo makes it easier
to:
- edit the files -- less indirection; can include linter updates as part
of regular commits during feature work)
- keep dependencies up to date -- there are ways to manage these npm
packages between multiple repos in lockstep but it's a lot more
complicated to do it like that
- support VS Code -- there's an unstated assumption among the standard
extensions that your language- and build-related npm packages are
installed at the top level of your projects. it's one more reason
an extension might be broken at any given time. your options are:
(1) install once, at the root level of the project, and rule out
that this is a problem
(2) install in your nested module and install a copy with a
matching version at the root level, too, update them in lockstep
and cross your fingers
shout out to Sublime / Neovim for not having this problem
p2edwards
force-pushed
the
update-move-linters-jun-24
branch
from
3fb0136
to
5f34eee
Compare
Show the prompt that lets VS Code run the local TypeScript version in your workspace, so it matches the output of `npx tsc`. --- The error in formGallery/utils.ts is weird. This StackOverflow snippet checks if something is an instance of an Object or Array. TS2358 aptly notices that the right-hand side of value instanceof Object || value instanceof Array will never be reached, since an array is also an instanceof Object. So this could become value instanceof Object …but to preserve the meaning of the code, I've just switched their order around. --- Updated TS while I'm at it, since the code still builds without an issue and it's nice to keep on top of it.
magicznyleszek
approved these changes
Jun 27, 2024
This was referenced Jul 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Update linter dependencies to support VS Code. Move colors.scss and linter definitions from kobotoolbox/kobo-common directly into kobotoolbox/kpi to make updating and development easier.
Notes
This PR fixes our linters so they work with current versions of VS Code extensions (eslint, Stylelint, Prettier), and changes the way these linters are loaded to make future updates easier.
colors.scssfrom kobo-common into kpi.Future plans for the linters include updating to ESLint 'flat config', separating 'stylistic' and 'inference' rules, and adding some library-specific linters.
Re-adopting these scripts in the kpi repo will make it easier to keep them working, up-to-date, and useful (congruent with our current practices). The kobo-common workflow was adding a little too much friction to common tasks, causing these files to get sidelined:
Importing them via npm adds several extra steps every time we:
One of the goals of kobo-common — to let other repos subscribe to common assets primarily created for kpi — can be replaced with a script, or a periodic semi-automated task, which doesn't need to happen very often. We can still accomplish 'DRY' by more primitive mechanisms, without paying the overhead of using npm + git hooks to factor these out.
Related issues
Part of #4703
Related to #4230
Checklist